Scripting > CxHmiGcm > NomGridCtrl Object > NomGridCtrl Properties

NomGridCtrl Properties

The CygNet GCM Nomination Grid Control object contains the following properties:

Property Sheet

Type

Read Only Description

Appearance

Short

No

Appearance specifies whether the object boundary (graph, cell in the grid, view, etc.) will have a 3D effect or a flat appearance. Options are 0 - Flat or 1 - 3D. Default is 0 - Flat.

BackColor

OLE_COLOR

No

Selects a background color for the object or grid. Note that if an object’s [AlarmElement] property is set to Background Color and a primary point is assigned to the object, the background color will change in Run mode to reflect the point status.

The default is Automatic, which is the background color of TheView for most objects.

Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).'

BorderStyle

Short

No

BorderStyle specifies the border style of the object boundary.

Most tools use one of these sets of options:

  • 0 - ibsNone, 1 - ibsRaised, or 2 - ibsLowered, and the default is 0 - ibsNone
  • 0 - None or 1 - Fixed Single, and the default is 0 - None

The Panel Switch Tool uses these options:

  • 0 - ibsLine, 1 - ibsRaised, 2 - ibsLowered, 3 - ibsTop, and 4 - ibsNone, and the default is 0 - ibsLine.

For the Box, Frame, and Text tools, the BorderStyle property specifies the style of the object’s foreground lines. The options are:

  • 0 - Normal, 1 - 3D, 2 - Sunken, 3 - Raised, and 4 - None
  • The default for the Box Tool is 0 - Normal. The default for the Frame Tool is 1 - 3D. The default for the Text Tool is 4 - None.

    If you use 2 - Sunken or 3 - Raised and the effect is not visible, change the object’s HiliteColor.

    If you use 0 - Normal, 2 - Sunken, or 3 - Raised, you can set the border width using the PenWidth property.

For TheFrame/TheView, the BorderStyle property specifies both the style of the object's border and whether the object can be resized by the user in Run mode. The default is 0 - Thin, which means the border is thin and the size is static. The other possible option is 1 - Resizing, which means the border is thicker and can be resized.

See also Appearance.

Script subtype is integer.

CellBackColor

OLE_COLOR

Yes

Specifies the background color of a cell. Default is white (RGB 255.255.255).

Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).'

CellForeColor

OLE_COLOR

Yes

Specifies the foreground color of a cell. Default is black (RGB 0.0.0).

Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).'

ColumnDefXml

String

No

Specifies the XML used to configure the grid columns. Raw XML can be typed into the text field on the ActiveX properties dialog box or configured via the Columns page on the CygNet GCM Nomination Grid Properties dialog box. If you use the second option, the ColumnDefXml text field auto-populates with XML.

ContractHour

Integer

No

Specifies the contract hour in the time zone of a client computer. Determines the hour at which the contract day begins. This property cannot be changed while the control is running.

DisplayXml

String

No

Specifies the XML used to configure the display colors. Raw XML can be typed into the text field on the ActiveX properties dialog box or configured via the Display page on the CygNet GCM Nomination Grid Properties dialog box. If you use the second option, the DisplayXml text field auto-populates with XML.

FacilityTag

String

No

The facility tag of the root node in a given navigation hierarchy. Only facilities below this facility in the hierarchy are displayed.

FilterXml

String

No

Specifies the XML used to configure filters and filter rules. Raw XML can be typed into the text field on the ActiveX properties dialog box or configured via the Filters page on the CygNet GCM Nomination Grid Properties dialog box. If you use the second option, the FilterXml text field auto-populates with XML.

Font

StdFont

No

Font specifies the font for the object.

For TheView, this property specifies the default font for text-based objects.

For other objects, it specifies the font for the instance of the object. The object’s font takes precedence over the font set for TheView.

Click to view the Font dialog box, which you can use to configure the font. The default is MS Shell Dlg (MS Sans Serif, regular, 8 pt). Script subtype is string.

Note: In script, you can set font properties using "-13, Arial" for example.

GeneralXml

String

No

Reflects the General page values on the Properties dialog box.

GroupHierarchy

String

No

Specifies the name of the group hierarchy you want to use and see displayed. The available options correspond to group hierarchies already set up in your Group Service for a given site. Only the names of possible root nodes appear. This is the same as that entered on the Settings page of the GCM device editor.

GroupService

String

No

Specifies the Site.Service of the Group service containing the group hierarchy. Be sure to select the Group service from the correct site. This is the same as that entered on the Settings page of the GCM device editor.

GroupView

String

No

Specifies the parent-child relationships between the components associated with the same component hierarchy root node. Multiple views may be created to provide different methods of filtering and displaying data, such as State, Route, and Operator, or Operator and State. This is the same as that entered on the Settings page of the GCM device editor.

HistoricalDate

Date

No

Enter a past date in this field to view calculations from that past date. You must also set the property HistoricalMode to 1 - Yes.

HistoricalMode

Boolean

No

Use this setting to view screens for dates prior to the current date. Options are 0 - No or 1 - Yes. Default is 0 - No. You must also enter a specific value for the property HistoricalDate.

LockedColumns

Integer

No

Number of leftmost columns to lock when scrolling horizontally.

LockedRows

Integer

No

Number of topmost rows to lock when scrolling vertically.

RefreshRate

Integer

No

Rate at which data automatically refreshes. On large hierarchies, the refresh can be slow — don’t refresh too often.

RowDefXml

String

No

Specifies the XML used to configure the grid rows. Raw XML can be typed into the text field on the ActiveX properties dialog box or configured via the Rows page on the CygNet GCM Nomination Grid Properties dialog box. If you use the second option, the RowDefXml text field auto-populates with XML.

StateColorEvaluation

EStateColorEvaluation

No

[StateColorEvaluation] specifies whether the object’s color is based on its point state or its alarm state. Options are 0 - Point State and 1 - Alarm State or 1 - ePOINT_STATE and 2 - eALARM_CONDITION. The default is 0 - Point State or 1 - ePOINT_STATE.

StateColorMode

EStateColorMode

No

[StateColorMode] Specifies if and how the object will show the alarm point’s state color: shown in a single color (1 - Single), dual colors (2 - Dual), or not at all (0 - Off). The default is Single. Options include:

  • Off (0 - eSTATECOLORMODE_OFF)
  • Single Color (1 - eSTATECOLORMODE_SINGLE)
  • Dual Colors (2 - eSTATECOLORMODE_DUAL)

Most tools have a Single mode. That is, they can reflect the point state color in a single element. The element is defined by an object’s [AlarmElement] property to specify if the state color will be shown in the object’s foreground or background. Objects that have [AlarmElement] options of both Foreground Color and Background Color, such as the Text Tool or a closed shape (ellipse, rectangle, polyline), can be configured using the [StateColorMode] property to show the point state color in dual mode; that is, both the Foreground and Background. For tools with a Dual mode, you must select the foreground and background colors using the [UseCustomStateColors] property. The default is 1 - eOFF. Options include:

  • 1 - eOFF
  • 2 - eSINGLE_FOREGROUND
  • 3 - eSINGLE_BACKGROUND
  • 4 - eDUAL
Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.